home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 January / macformat-020.iso / Shareware City / Developers / Commander Sets / 4D Speech Pack / 4D Speech Pack.rsrc / TEXT_19054_†Functions Overview.txt < prev    next >
Encoding:
Text File  |  1994-09-14  |  6.7 KB  |  121 lines

  1. Functions Overview
  2.  
  3. The functions and commands included in this external package can be grouped into six sets. These are:
  4.  ‚Ä¢ Speech Channels
  5.  ‚Ä¢ Channels Information
  6.  ‚Ä¢ Quick Speak
  7.  ‚Ä¢ General Settings
  8.  ‚Ä¢ General Information
  9.  ‚Ä¢ Compatibility
  10. Inside the Design Environment of 4D you will see these names also as the titles of the pop-up menus in the lower right side with the functions in the procedure window.
  11.  
  12. Speech Channels
  13. Below are the functions listed which allow you to open and close a speech channel and pass a string or text to it in order to have it spoken, to convert it or to control the speech:
  14.  
  15. Function                 Description                                              
  16. SP Open Voice        Open a speech channel using the specified
  17.                              voice.
  18. SP Close Voice       Close an opened speech channel.
  19. SP Voice String      Pass a string to a speech channel.
  20. SP Voice Text         Pass (part of) a text to a speech channel.
  21. SP Voice code         Pass a string and get the phoneme code
  22.                               back.
  23. SP Voice sound       Pass a string and the sound will be stored
  24.                               on disk.
  25. SP Voice Pause       Pause a voice from speaking.
  26. SP Voice Cont         Let a paused voice continue speaking.
  27. SP Voice Stop         Stop a voice from speaking.
  28.  
  29. These functions allow you greater flexibility, compared with the ‚ÄùSpeak Quick‚Äú functions, but may take a lot of careful programming.
  30.  
  31.  
  32. Channels Information
  33. These are the functions to obtain and set information of a particular speech channel status and settings:
  34.  
  35. Function                Description                                              
  36. SP Voice busy        Is the speech channel still chewing on the
  37.                              lines of text?
  38. SP Voice reset       Reset the values and behaviour to the
  39.                              default.
  40. SP Get Attr           Get the rate and pitch of a voice.
  41. SP Set Attr           Set the rate and pitch of a voice.
  42.  
  43.  
  44. Speak Quick
  45. These functions allow you to speak a string or text without the need of opening a speech channel, but the control will not return until the Speech Manager has finished speaking:
  46.  
  47. Function                 Description                                              
  48. SP Speak String     Speak a string now!
  49. SP Speak Text        Speak (part of) a text now!
  50.  
  51. These functions are easy to implement and may be sufficient for some data-bases.
  52.  
  53.  
  54. General Settings
  55. These commands enable you to obtain or set some general settings :
  56.  
  57. Function                 Description                                              
  58. SP SPEECH ON       Turn speech capabilities of Speech Pack on.
  59. SP SPEECH OFF      Turn speech capabilities of Speech Pack off.
  60. SP Features           Determine which features are implemented
  61.                              with this version of Speech Pack.
  62. SP Pick Voice        Present the user with a standard settings
  63.                              dialog to pick a voice.
  64.  
  65.  
  66. General Information
  67. The following functions and commands allow you to obtain information about the external package, voices and the current status of the computer regarding speech:
  68.  
  69. Function                Description                                              
  70. SP Can speak         Is the Speech Manager present and the
  71.                              external set up properly?
  72. SP VERSION           What is the version of the Speech Manager
  73.                              and Speech Pack?
  74. SP Count voices     How many voices are installed?
  75. SP Count open        And how many voices are opened with
  76.                              Speech Pack?
  77. SP Voicename        What's the name of a installed voice or
  78.                              used for a speech channel?
  79. SP VOICES ARRAY What are the names of all installed voices?
  80. SP Voice Info         What's the comment, gender and age of a
  81.                              voice?
  82. SP Language          What's the language, region and script the
  83.                              voice can handle?
  84. SP Voice Type       What type of synthesizer is this voice for,
  85.                              its creator, id and were on disk is its data
  86.                              located?
  87. SP Speaking           How many speech channels are speaking on
  88.                              this computer?
  89. SP COPYRIGHT       Which version of Speeck Pack is this, and
  90.                              who wrote it?
  91.  
  92.  
  93. Compatibility
  94. Any function or procedure below is to replace earlier externals which used the original MacinTalk system extension. These are included ONLY for compatibility and should not be used in any new data-base.
  95.  
  96. Function                 Description                                              
  97. Say                       Emulate the Say external (freeware) by
  98.                              Djundi Karjadi, Natural Intelligence
  99.                              Consulting, Boston, Mass.
  100.                              (latest known version is 1.2, 1988)
  101. PARLE                   Emulate the PARLE function from the
  102.                              Macintalk RE (freeware) external package by
  103.                              David Halfon, France. Only known version
  104.                              published in 1992. The original external
  105.                              was mailed to me by Philippe Giraud.
  106.                             (BTW ‚Äùparle‚Äú is French for ‚Äùspeak‚Äú.)
  107. SP Channel           <NOT USABLE, UNDOCUMENTED>
  108.  
  109. WARNING:
  110. Remove or rename the original ‚ÄùSay‚Äú and ‚ÄùPARLE‚Äú externals before installing Speeck Pack!
  111.  
  112. If you know of any other external which uses the original MacinTalk and you want to see it replaced, please email me at least the documentation and if possible the external itself. I will look at it and may decide to add a function to Speech Pack to replace the original external.
  113. These functions are included for compatibility only and should not be used with any new 4D data-base. If you have replaced the original external with any of the functions listed above please inform me about it. Send an email, postcard or whatever. If I don't receive any such message the function may be removed in the future.
  114.  
  115. Because there are a lot of things outside 4D and Speech Pack which may change or have an effect on the speech, you need to check the error numbers returned thoroughly. Defensive programming is really necessary. For example, if an error is reported when using SP Open Voice, you don't need to call SP Close Voice simply because opening failed.
  116. This is also the reason why the functions return error numbers. Just a one or zero doesn't provide enough information. You can use also the ErrorString external I have published to get the full string describing the error.
  117. You should be prepared to handle error numbers which are not listed with each function in this manual, but may be added in the future.
  118.  
  119.  
  120.  
  121.